<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>WriteConcern | mongodb</title>
	<meta name="description" content="Documentation for mongodb">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
	<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">mongodb</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-externals" checked />
							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../modules.html">mongodb</a>
				</li>
				<li>
					<a href="WriteConcern.html">WriteConcern</a>
				</li>
			</ul>
			<h1>Class WriteConcern</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>A MongoDB WriteConcern, which describes the level of acknowledgement
						requested from MongoDB for write operations.</p>
					</div>
					<dl class="tsd-comment-tags">
						<dt>see</dt>
						<dd><p><a href="https://www.mongodb.com/docs/manual/reference/write-concern/">https://www.mongodb.com/docs/manual/reference/write-concern/</a></p>
						</dd>
					</dl>
				</div>
			</section>
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">WriteConcern</span>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Constructors</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="WriteConcern.html#constructor" class="tsd-kind-icon">constructor</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Properties</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-property tsd-parent-kind-class"><a href="WriteConcern.html#fsync" class="tsd-kind-icon">fsync</a></li>
								<li class="tsd-kind-property tsd-parent-kind-class"><a href="WriteConcern.html#j" class="tsd-kind-icon">j</a></li>
								<li class="tsd-kind-property tsd-parent-kind-class"><a href="WriteConcern.html#w" class="tsd-kind-icon">w</a></li>
								<li class="tsd-kind-property tsd-parent-kind-class"><a href="WriteConcern.html#wtimeout" class="tsd-kind-icon">wtimeout</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Methods</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="WriteConcern.html#fromOptions" class="tsd-kind-icon">from<wbr>Options</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Constructors</h2>
				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
					<a name="constructor" class="tsd-anchor"></a>
					<h3>constructor</h3>
					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">new <wbr>Write<wbr>Concern<span class="tsd-signature-symbol">(</span>w<span class="tsd-signature-symbol">?: </span><a href="../modules.html#W" class="tsd-signature-type" data-tsd-kind="Type alias">W</a>, wtimeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, j<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, fsync<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">1</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/c9a962f1/src/write_concern.ts#L54">src/write_concern.ts:54</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Constructs a WriteConcern from the write concern properties.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5><span class="tsd-flag ts-flagOptional">Optional</span> w: <a href="../modules.html#W" class="tsd-signature-type" data-tsd-kind="Type alias">W</a></h5>
									<div class="tsd-comment tsd-typography">
										<div class="lead">
											<p>request acknowledgment that the write operation has propagated to a specified number of mongod instances or to mongod instances with specified tags.</p>
										</div>
									</div>
								</li>
								<li>
									<h5><span class="tsd-flag ts-flagOptional">Optional</span> wtimeout: <span class="tsd-signature-type">number</span></h5>
									<div class="tsd-comment tsd-typography">
										<div class="lead">
											<p>specify a time limit to prevent write operations from blocking indefinitely</p>
										</div>
									</div>
								</li>
								<li>
									<h5><span class="tsd-flag ts-flagOptional">Optional</span> j: <span class="tsd-signature-type">boolean</span></h5>
									<div class="tsd-comment tsd-typography">
										<div class="lead">
											<p>request acknowledgment that the write operation has been written to the on-disk journal</p>
										</div>
									</div>
								</li>
								<li>
									<h5><span class="tsd-flag ts-flagOptional">Optional</span> fsync: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">1</span></h5>
									<div class="tsd-comment tsd-typography">
										<div class="lead">
											<p>equivalent to the j option</p>
										</div>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></h4>
						</li>
					</ul>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Properties</h2>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
					<a name="fsync" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> fsync</h3>
					<div class="tsd-signature tsd-kind-icon">fsync<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">1</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/c9a962f1/src/write_concern.ts#L45">src/write_concern.ts:45</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>equivalent to the j option</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
					<a name="j" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> j</h3>
					<div class="tsd-signature tsd-kind-icon">j<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/c9a962f1/src/write_concern.ts#L43">src/write_concern.ts:43</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>request acknowledgment that the write operation has been written to the on-disk journal</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
					<a name="w" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> w</h3>
					<div class="tsd-signature tsd-kind-icon">w<span class="tsd-signature-symbol">:</span> <a href="../modules.html#W" class="tsd-signature-type" data-tsd-kind="Type alias">W</a></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/c9a962f1/src/write_concern.ts#L39">src/write_concern.ts:39</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>request acknowledgment that the write operation has propagated to a specified number of mongod instances or to mongod instances with specified tags.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
					<a name="wtimeout" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> wtimeout</h3>
					<div class="tsd-signature tsd-kind-icon">wtimeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/c9a962f1/src/write_concern.ts#L41">src/write_concern.ts:41</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>specify a time limit to prevent write operations from blocking indefinitely</p>
						</div>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Methods</h2>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
					<a name="fromOptions" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Options</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
						<li class="tsd-signature tsd-kind-icon">from<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#W" class="tsd-signature-type" data-tsd-kind="Type alias">W</a>, inherit<span class="tsd-signature-symbol">?: </span><a href="../interfaces/WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/c9a962f1/src/write_concern.ts#L74">src/write_concern.ts:74</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Construct a WriteConcern given an options object.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#W" class="tsd-signature-type" data-tsd-kind="Type alias">W</a></h5>
								</li>
								<li>
									<h5><span class="tsd-flag ts-flagOptional">Optional</span> inherit: <a href="../interfaces/WriteConcernOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernOptions</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></h4>
						</li>
					</ul>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class=" ">
						<a href="../modules.html">Exports</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
				</ul>
				<ul class="current">
					<li class="current tsd-kind-class">
						<a href="WriteConcern.html" class="tsd-kind-icon">Write<wbr>Concern</a>
						<ul>
							<li class=" tsd-kind-constructor tsd-parent-kind-class">
								<a href="WriteConcern.html#constructor" class="tsd-kind-icon">constructor</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-class">
								<a href="WriteConcern.html#fsync" class="tsd-kind-icon">fsync</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-class">
								<a href="WriteConcern.html#j" class="tsd-kind-icon">j</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-class">
								<a href="WriteConcern.html#w" class="tsd-kind-icon">w</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-class">
								<a href="WriteConcern.html#wtimeout" class="tsd-kind-icon">wtimeout</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
								<a href="WriteConcern.html#fromOptions" class="tsd-kind-icon">from<wbr>Options</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>